// 版权所有2010 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// 包后缀数组使用内存中的后缀数组
// 在对数时间内实现子字符串搜索。
// 
// 示例用法：
// 
// /为某些数据创建索引
// /索引：=后缀数组。新（数据）
// 
// /查找字节片s 
// /偏移量1:=索引。Lookup（s，-1）
// offsets2:=index中出现s的所有索引的列表。Lookup（s，3）
// 
package suffixarray

import (
	"bytes"
	"encoding/binary"
	"errors"
	"io"
	"math"
	"regexp"
	"sort"
)

// 中最多包含3个索引的列表可以更改为测试
var maxData32 int = realMaxData32

const realMaxData32 = math.MaxInt32

// 索引实现了一个用于快速子字符串搜索的后缀数组。
type Index struct {
	data []byte
	sa   ints // 数据的后缀数组；萨。len（）==len（数据）
}

// ints是[]int32或[]int64。
// 也就是说，其中一个是空的，另一个是真实数据。
// 当len（data）>maxData32 
type ints struct {
	int32 []int32
	int64 []int64
}

func (a *ints) len() int {
	return len(a.int32) + len(a.int64)
}

func (a *ints) get(i int) int64 {
	if a.int32 != nil {
		return int64(a.int32[i])
	}
	return a.int64[i]
}

func (a *ints) set(i int, v int64) {
	if a.int32 != nil {
		a.int32[i] = int32(v)
	} else {
		a.int64[i] = v
	}
}

func (a *ints) slice(i, j int) ints {
	if a.int32 != nil {
		return ints{a.int32[i:j], nil}
	}
	return ints{nil, a.int64[i:j]}
}

// New为数据创建新索引时，使用int64表单。
// 对于N=len（数据），索引创建时间为O（N）。
func New(data []byte) *Index {
	ix := &Index{data: data}
	if len(data) <= maxData32 {
		ix.sa.int32 = make([]int32, len(data))
		text_32(data, ix.sa.int32)
	} else {
		ix.sa.int64 = make([]int64, len(data))
		text_64(data, ix.sa.int64)
	}
	return ix
}

// writeInt使用buf缓冲写入，将int x写入w。
func writeInt(w io.Writer, buf []byte, x int) error {
	binary.PutVarint(buf, int64(x))
	_, err := w.Write(buf[0:binary.MaxVarintLen64])
	return err
}

// readInt使用buf缓冲读取并返回x。
func readInt(r io.Reader, buf []byte) (int64, error) {
	_, err := io.ReadFull(r, buf[0:binary.MaxVarintLen64]) // 确定继续执行错误
	x, _ := binary.Varint(buf)
	return x, err
}

// writeSlice将数据[：n]写入w并返回n。
// 它使用buf缓冲写入。
func writeSlice(w io.Writer, buf []byte, data ints) (n int, err error) {
	// 将尽可能多的元素编码到buf 
	p := binary.MaxVarintLen64
	m := data.len()
	for ; n < m && p+binary.MaxVarintLen64 <= len(buf); n++ {
		p += binary.PutUvarint(buf[p:], uint64(data.get(n)))
	}

	// 更新缓冲区大小
	binary.PutVarint(buf, int64(p))

	// 写入缓冲区
	_, err = w.Write(buf[0:p])
	return
}

var errTooBig = errors.New("suffixarray: data too large")

// 读片从r读取数据[：n]并返回n。
// 它使用buf缓冲读取的数据。
func readSlice(r io.Reader, buf []byte, data ints) (n int, err error) {
	// 读取缓冲区大小
	var size64 int64
	size64, err = readInt(r, buf)
	if err != nil {
		return
	}
	if int64(int(size64)) != size64 || int(size64) < 0 {
		// 无论如何，我们都不会写这么大的块。
		return 0, errTooBig
	}
	size := int(size64)

	// 读取缓冲区，不包含大小
	if _, err = io.ReadFull(r, buf[binary.MaxVarintLen64:size]); err != nil {
		return
	}

	// 解码buf中的元素
	for p := binary.MaxVarintLen64; p < size; n++ {
		x, w := binary.Uvarint(buf[p:])
		data.set(n, int64(x))
		p += w
	}

	return
}

const bufSize = 16 << 10 // 对于基准测试是合理的Averarestore 

// 读取从r到x的索引；x不能为零。
func (x *Index) Read(r io.Reader) error {
	// 所有读取的缓冲区
	buf := make([]byte, bufSize)

	// 读取长度
	n64, err := readInt(r, buf)
	if err != nil {
		return err
	}
	if int64(int(n64)) != n64 || int(n64) < 0 {
		return errTooBig
	}
	n := int(n64)

	// 分配空间
	if 2*n < cap(x.data) || cap(x.data) < n || x.sa.int32 != nil && n > maxData32 || x.sa.int64 != nil && n <= maxData32 {
		// 新数据明显小于或大于
		// 现有缓冲区-分配新缓冲区
		x.data = make([]byte, n)
		x.sa.int32 = nil
		x.sa.int64 = nil
		if n <= maxData32 {
			x.sa.int32 = make([]int32, n)
		} else {
			x.sa.int64 = make([]int64, n)
		}
	} else {
		// 重新使用现有缓冲区
		x.data = x.data[0:n]
		x.sa = x.sa.slice(0, n)
	}

	// 读取数据
	if _, err := io.ReadFull(r, x.data); err != nil {
		return err
	}

	// 读取索引
	sa := x.sa
	for sa.len() > 0 {
		n, err := readSlice(r, buf, sa)
		if err != nil {
			return err
		}
		sa = sa.slice(n, sa.len())
	}
	return nil
}

// 写入索引xto w.
func (x *Index) Write(w io.Writer) error {
	// 所有写入的缓冲区
	buf := make([]byte, bufSize)

	// 写入长度
	if err := writeInt(w, buf, len(x.data)); err != nil {
		return err
	}

	// 写入数据
	if _, err := w.Write(x.data); err != nil {
		return err
	}

	// 写入索引
	sa := x.sa
	for sa.len() > 0 {
		n, err := writeSlice(w, buf, sa)
		if err != nil {
			return err
		}
		sa = sa.slice(n, sa.len())
	}
	return nil
}

// 字节返回创建索引的数据。
// 不能修改。
// 
func (x *Index) Bytes() []byte {
	return x.data
}

func (x *Index) at(i int) []byte {
	return x.data[x.sa.get(i):]
}

// lookupAll返回索引匹配区域的一个切片。
// 运行时为O（log（N）*len（s））。
func (x *Index) lookupAll(s []byte) ints {
	// 查找匹配的后缀索引范围[i:j]
	// 查找第一个索引，其中s将是前缀
	i := sort.Search(x.sa.len(), func(i int) bool { return bytes.Compare(x.at(i), s) >= 0 })
	// 从i开始，查找第一个s不是前缀的索引
	j := i + sort.Search(x.sa.len()-i, func(j int) bool { return !bytes.HasPrefix(x.at(j+i), s) })
	return x.sa.slice(i, j)
}

// 查找返回一个未排序的索引列表，其中字节字符串s 
// 出现在索引数据中。如果n<0，则返回所有事件。
// 如果s为空，找不到s，或n==0，则结果为零。
// 查找时间是O（log（N）*len（s）+len（result）），其中N是索引数据的大小。
// 
func (x *Index) Lookup(s []byte, n int) (result []int) {
	if len(s) > 0 && n != 0 {
		matches := x.lookupAll(s)
		count := matches.len()
		if n < 0 || count < n {
			n = count
		}
		// 0<=n<=count 
		if n > 0 {
			result = make([]int, n)
			if matches.int32 != nil {
				for i := range result {
					result[i] = int(matches.int32[i])
				}
			} else {
				for i := range result {
					result[i] = int(matches.int64[i])
				}
			}
		}
	}
	return
}

// FindAllIndex返回
// 正则表达式r的非重叠匹配项的排序列表，其中匹配项是一对指定
// x.Bytes（）的匹配片段的索引。如果n<0，则所有匹配项都将按顺序返回
// 。否则，最多返回n个匹配，
// 它们可能不是连续的。如果没有匹配项，
// 或n==0，则结果为零。
// 
func (x *Index) FindAllIndex(r *regexp.Regexp, n int) (result [][]int) {
	// 非空文字前缀用于确定可能的
	// 将开始索引与查找
	prefix, complete := r.LiteralPrefix()
	lit := []byte(prefix)

	// 最坏情况：无文字前缀
	if prefix == "" {
		return r.FindAllIndex(x.data, n)
	}

	// 如果regexp是文字，只需使用查找并将其
	// 结果转换为匹配对
	if complete {
		// 查找返回可能属于的索引重复匹配。
		// 消除它们后，我们可能会得到少于n个匹配项。
		// 如果我们最后没有足够的数据，请使用
		// 增加的值n1重新进行搜索，但前提是Lookup首先返回所有请求的
		// 索引（如果返回的数量少于此数量，则
		// 不能再多了）。
		for n1 := n; ; n1 += 2 * (n - len(result)) /* overflow ok */ {
			indices := x.Lookup(lit, n1)
			if len(indices) == 0 {
				return
			}
			sort.Ints(indices)
			pairs := make([]int, 2*len(indices))
			result = make([][]int, len(indices))
			count := 0
			prev := 0
			for _, i := range indices {
				if count == n {
					break
				}
				// 忽略导致重叠匹配的索引
				if prev <= i {
					j := 2 * count
					pairs[j+0] = i
					pairs[j+1] = i + len(lit)
					result[count] = pairs[j : j+2]
					count++
					prev = i + len(lit)
				}
			}
			result = result[0:count]
			if len(result) >= n || len(indices) != n1 {
				// 找到了所有匹配项，或者没有机会找到更多
				// （n和n1可以为负）
				break
			}
		}
		if len(result) == 0 {
			result = nil
		}
		return
	}

	// regexp有一个非空的文字前缀；查找（lit）计算
	// 可能完全匹配的索引；使用这些作为起始点
	// 重叠匹配

	for n1 := n; ; n1 += 2 * (n - len(result)) /* overflow ok */ {
		indices := x.Lookup(lit, n1)
		if len(indices) == 0 {
			return
		}
		sort.Ints(indices)
		result = result[0:0]
		prev := 0
		for _, i := range indices {
			if len(result) == n {
				break
			}
			if m != nil && prev <= i {
				m[0] = i // 更正m 
				m[1] += i
				result = append(result, m)
				prev = m[1]
			}
		}
		if len(result) >= n || len(indices) != n1 {
			// 找到了所有匹配项，或者没有机会找到更多
			// （n和n1可以是负数）
			break
		}
	}
	if len(result) == 0 {
		result = nil
	}
	return
}
